<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: Trace Extension APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.9.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__trace__extension__apis.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Trace Extension APIs<div class="ingroups"><a class="el" href="group__trace__recorder__apis.html">Trace Recorder APIs</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga0e4ca1424c866797c717daaa117937a1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__extension__apis.html#ga0e4ca1424c866797c717daaa117937a1">xTraceExtensionGetEventId</a>(xExtensionHandle,  uiLocalEventId)&#160;&#160;&#160;((uint32_t)xTraceEntryGetStateReturn((TraceEntryHandle_t)(xExtensionHandle), TRC_EXTENSION_STATE_INDEX_BASE_EVENT_ID) + (uiLocalEventId))</td></tr>
<tr class="memdesc:ga0e4ca1424c866797c717daaa117937a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns extension event id.  <br /></td></tr>
<tr class="separator:ga0e4ca1424c866797c717daaa117937a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8f46fe1125fb7f6dbf9a4ee62e51baed"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__extension__apis.html#ga8f46fe1125fb7f6dbf9a4ee62e51baed">xTraceExtensionInitialize</a> (TraceExtensionData_t *const pxBuffer)</td></tr>
<tr class="memdesc:ga8f46fe1125fb7f6dbf9a4ee62e51baed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the Extension trace system.  <br /></td></tr>
<tr class="separator:ga8f46fe1125fb7f6dbf9a4ee62e51baed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga358cdec30d87e1659cbb5dc551c5c310"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__extension__apis.html#ga358cdec30d87e1659cbb5dc551c5c310">xTraceExtensionCreate</a> (const char *szName, uint8_t uiMajor, uint8_t uiMinor, uint16_t uiPatch, uint32_t uiEventCount, TraceExtensionHandle_t *pxExtensionHandle)</td></tr>
<tr class="memdesc:ga358cdec30d87e1659cbb5dc551c5c310"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates trace extension.  <br /></td></tr>
<tr class="separator:ga358cdec30d87e1659cbb5dc551c5c310"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c1bab5acbdfd9d0d825de688cfc635b"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__extension__apis.html#ga9c1bab5acbdfd9d0d825de688cfc635b">xTraceExtensionGetBaseEventId</a> (TraceExtensionHandle_t xExtensionHandle, uint32_t *puiBaseEventId)</td></tr>
<tr class="memdesc:ga9c1bab5acbdfd9d0d825de688cfc635b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets extension base event id.  <br /></td></tr>
<tr class="separator:ga9c1bab5acbdfd9d0d825de688cfc635b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae8fbcb9415c4b62b395923ad9d716ddd"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__extension__apis.html#gae8fbcb9415c4b62b395923ad9d716ddd">xTraceExtensionGetConfigName</a> (TraceExtensionHandle_t xExtensionHandle, const char **pszName)</td></tr>
<tr class="memdesc:gae8fbcb9415c4b62b395923ad9d716ddd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets extension configuration name.  <br /></td></tr>
<tr class="separator:gae8fbcb9415c4b62b395923ad9d716ddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga0e4ca1424c866797c717daaa117937a1" name="ga0e4ca1424c866797c717daaa117937a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0e4ca1424c866797c717daaa117937a1">&#9670;&#160;</a></span>xTraceExtensionGetEventId</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceExtensionGetEventId</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xExtensionHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uiLocalEventId&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;((uint32_t)xTraceEntryGetStateReturn((TraceEntryHandle_t)(xExtensionHandle), TRC_EXTENSION_STATE_INDEX_BASE_EVENT_ID) + (uiLocalEventId))</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns extension event id. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xExtensionHandle</td><td>Pointer to initialized extension handle. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiLocalEventId</td><td>Local event id.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Extension event id </dd></dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga358cdec30d87e1659cbb5dc551c5c310" name="ga358cdec30d87e1659cbb5dc551c5c310"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga358cdec30d87e1659cbb5dc551c5c310">&#9670;&#160;</a></span>xTraceExtensionCreate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceExtensionCreate </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>uiMajor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>uiMinor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>uiPatch</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiEventCount</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceExtensionHandle_t *&#160;</td>
          <td class="paramname"><em>pxExtensionHandle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates trace extension. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiMajor</td><td>Major version. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiMinor</td><td>Minor version. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiPatch</td><td>Patch version. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiEventCount</td><td>Event count. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxExtensionHandle</td><td>Pointer to uninitialized extension handle.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga9c1bab5acbdfd9d0d825de688cfc635b" name="ga9c1bab5acbdfd9d0d825de688cfc635b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9c1bab5acbdfd9d0d825de688cfc635b">&#9670;&#160;</a></span>xTraceExtensionGetBaseEventId()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceExtensionGetBaseEventId </td>
          <td>(</td>
          <td class="paramtype">TraceExtensionHandle_t&#160;</td>
          <td class="paramname"><em>xExtensionHandle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>puiBaseEventId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets extension base event id. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xExtensionHandle</td><td>Pointer to initialized extension handle. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">puiBaseEventId</td><td>Base event id.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gae8fbcb9415c4b62b395923ad9d716ddd" name="gae8fbcb9415c4b62b395923ad9d716ddd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae8fbcb9415c4b62b395923ad9d716ddd">&#9670;&#160;</a></span>xTraceExtensionGetConfigName()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceExtensionGetConfigName </td>
          <td>(</td>
          <td class="paramtype">TraceExtensionHandle_t&#160;</td>
          <td class="paramname"><em>xExtensionHandle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char **&#160;</td>
          <td class="paramname"><em>pszName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets extension configuration name. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xExtensionHandle</td><td>Pointer to initialized extension handle. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pszName</td><td>Name.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga8f46fe1125fb7f6dbf9a4ee62e51baed" name="ga8f46fe1125fb7f6dbf9a4ee62e51baed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8f46fe1125fb7f6dbf9a4ee62e51baed">&#9670;&#160;</a></span>xTraceExtensionInitialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceExtensionInitialize </td>
          <td>(</td>
          <td class="paramtype">TraceExtensionData_t *const&#160;</td>
          <td class="paramname"><em>pxBuffer</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the Extension trace system. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pxBuffer</td><td>Pointer to memory that is used by the extension trace system</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
